Add a deprecation warning for 'ENVIRONMENT' & env fallback #277
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ccapell
approved these changes
Aug 11, 2022
arm4b
commented
Aug 11, 2022
Comment on lines
+54
to
+58
| # TODO: Drop support for 'ENVIRONMENT' env var | ||
| if 'ENVIRONMENT' in os.environ: | ||
| logger.warning( | ||
| "'ENVIRONMENT' var is deprecated in v2.0.0 and will be removed in the future versions! " | ||
| "Use the 'BITOPS_ENVIRONMENT' env var instead!" |
There was a problem hiding this comment.
Now that ENVIRONMENT is deprecated in v2.0.0 in favor of new BITOPS_ENVIRONMENT, but we're handling the case gracefully by merging the values.
The question though, in which BitOps version do we want to drop the ENVIRONMENT var completely?
There was a problem hiding this comment.
i'd create an issue/discussion so we can discuss (also to add it to the roadmap)
There was a problem hiding this comment.
Created a note here: #245 (comment) in the "Roadmap" Discussion so it's not lost.
mickmcgrath13
approved these changes
Aug 11, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In v2.0.0 the
ENVIRONMENTwas dropped and replaced withBITOPS_ENVIRONMENT.Per discussion in #269 (comment) instead of erroring, we try to guess if the user is still relying on the old var, try to handle it gracefully by injecting the old value into the new
BITOPS_ENVIRONMENT, and give a Deprecation Warning.